Improve documentation of the metrics.exclude parameter Change-Id: Ic3b0f7fee016a13a663400499e7277632378e010
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index f45f16f..070151f 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -25,11 +25,12 @@ for how to configure the integration with Prometheus. plugin.@PLUGIN@.excludeMetrics -: String used to exclude metrics from the report. It can be specified multiple times. - Parsed as regular expression. Note, ^ and $ are automatically added around the string. +: Regex pattern used to exclude metrics from the report. It can be specified multiple times. + Note that pattern matching is done on the whole metric name, not only on a part of it. By default no metric is excluded. For example, to exclude all cache metrics, use: `excludeMetrics = cache.*` + [Back to @PLUGIN@ documentation index][index] [index]: index.html